Add or Create a New API
What
Adding or creating a new API. Specific team members can add new APIs.
- NOT Session-specific—Adding an API, is not session-specific. The API remains unless and until it is deliberately deleted.
- NOT User-specific—The APIs are visible to all of your company’s team members who access APIs in PortX.
- Confirmation message—A system confirmation message DOES appear in the upper right of the page, to show successful addition of a new API.
Where
Where is an API added? Adding an API is initiated on the API Catalog Page, then the details are in the New API page.
When
When should APIs be added or created? As needed to meet your company’s business needs.
Who
Who should add APIs? The Team Members to whom your company has granted permission and authorized to add new APIs.
Why
Why add APIs? Add them as needed for your company’s business needs.
How
How to add or create a new API? Instructions and screen captures are provided here in this section of the PortX Platform documentation.
From the API Catalog page, which is the Discover Module Main Page, click on the ADD NEW button (as shown in Figure 14).
The New API Page opens (as shown in Figure 15).
Fill in the following information (6 fields in the 1st column). The Save button does not appear until you select a template in the 2nd column.
- ID—required—must be at least 5 characters
- Name must be unique and it follows the same rules as a GitHub repo and it creates a GitHub repo.
- Must be lower case letter, numbers, hyphens. No special characters or spaces are allowed.
- Label—required—maximum 20 characters
- Description—required
- OpenApi Specification—autogenerates and is editable
- By default this points to a certain folder but is editable in case you want to place it somewhere else
- Swagger file
- API Documentation Site—autogenerates
- ECR Repository—autogenerates and is editable
- Container registry
- Editable in case you have your own build process
Continue filling in the following information (6 fields in the 2nd column)
- Tags—optional
- Drop down menu
- Choices are existing tags
- GitOps Repository—autogenerates and is editable
- Charts Repository—autogenerates and is editable
- Code Repository—autogenerates and is editable
- API Documentation Repository—autogenerates and is editable
- API Template—required—when you select a template, the Save button appears.
Before clicking on Save, you can change your template selection.
- Framework templates, or they can be pre-built such as actual code, or a starting point for an application
- One of the following choices:
- Camel/Quarkus—Native compiling that makes the container start faster with less memory and behaves better in Kubernates. Kubernates restarts and moves things around so the faster it is, the better it is.
- Camel/Springboot
- Default—blank GitHub default repo with no code
- Karavan—low code tool for visual designer
- Account Opening Flow—one of the common scenarios that financial institutions use
- Karavan Common—if you want to make a Karavan template
Below the 12 fields is Advanced Settings:
- Provisioning—When creating the API, the system provisions the GitHub repo, the ECR instance, and installs into the Gitops App
- Github repo
- Ecr repo
- Gitops App
Any or all of these can be removed (deleted) later if you are deleting the API. Provisioning of these canNOT be added at a later time.
After selecting the API Template, the Save button becomes available.
Review your selections for your entries. Some selections are not editable and need to be set correctly. (If you create an API with an uneditable field that is incorrect, you can delete the API and start again by creating a new one.)
Click on Save.
A confirmation message briefly appears in the upper right corner of the page (as shown in Figure 18) to show the successful completion of adding an API.
The new API may take a few minutes to appear in the API Catalog.
